package com.zzw.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger配置类
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    // 可配置是否启用Swagger，生产环境可以考虑关闭
    private boolean swaggerEnabled = true;

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * select() 返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
     * apis() 指定扫描的包路径来定义指定要建立API的目录
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(swaggerEnabled) // 是否启用Swagger
                .select()
                // 更精确地只扫描controller包中的RestController和Controller注解
                .apis(RequestHandlerSelectors.basePackage("com.zzw.controller"))
                // 只扫描 /api 路径下的接口
                //.paths(PathSelectors.regex("/api/.*"))
                .paths(PathSelectors.any())
                .build()
                // 忽略某些通用参数
                .ignoredParameterTypes(java.sql.Date.class, java.sql.Timestamp.class)
                // 设置是否使用默认响应消息
                .useDefaultResponseMessages(false);
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("系统接口文档")
                .description("基于Swagger2的API文档")
                .termsOfServiceUrl("http://localhost:8080/")
                .contact(new Contact("开发团队", "", ""))
                .version("1.0")
                .build();
    }
}
